<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Button debouncer example</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51 General Code Examples
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__debouncer__example.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">Button debouncer example</div>  </div>
<div class="ingroups"><a class="el" href="group__nrf__examples__nrf6310.html">nRF6310 example projects</a></div></div>
<div class="contents">

<p>Example project on GPIO usage with integrator debouncer to read GPIO pin states.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga17cea4a999ebdae31473f0d7fe9ed1f3"></a><!-- doxytag: member="debouncer_example::DEBOUNCE_TIME_IN_MS" ref="ga17cea4a999ebdae31473f0d7fe9ed1f3" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga17cea4a999ebdae31473f0d7fe9ed1f3">DEBOUNCE_TIME_IN_MS</a>&#160;&#160;&#160;(50U)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Debounce timer in milliseconds. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf53454acf2798331622dabf5c62e677f"></a><!-- doxytag: member="debouncer_example::DEBOUNCE_INPUT_SAMPLING_FREQ" ref="gaf53454acf2798331622dabf5c62e677f" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#gaf53454acf2798331622dabf5c62e677f">DEBOUNCE_INPUT_SAMPLING_FREQ</a>&#160;&#160;&#160;(60U)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Input sampling frequency in Hertz. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga747c4d9ce46cbb1df94436ed5e5bb749">TIMER0_PRESCALER</a>&#160;&#160;&#160;(9UL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga5040eaf7cc2530fd7801a1c72552767a">TIMER0_CLOCK</a>&#160;&#160;&#160;(SystemCoreClock &gt;&gt; TIMER0_PRESCALER)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#gade0ac7f737311be0e76142d713a6f3da">MS_TO_TIMER0_TICKS</a>(ms)&#160;&#160;&#160;((1000000UL * ms) / (TIMER0_CLOCK))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga8bb0c7f312bb8665c3377a061dae552c">MAX_BUTTONS</a>&#160;&#160;&#160;(8U)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#gadd186346e02f7413d2fa6e72fe5f9562">timer0_init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga5f89e5f7418d3a10f49b2faeab3711dd">TIMER0_IRQHandler</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint_fast16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga795c8489e6b86dbbdeb0ad800e9bc48a">timer0_cc0_period</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structdeb__t.html">deb_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__debouncer__example.html#ga904201e2b12ea5a8feacc85a67d33832">button</a> [MAX_BUTTONS]</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Example project on GPIO usage with integrator debouncer to read GPIO pin states. </p>
<div class="image">
<img src="example_board_setup_a.png" alt="example_board_setup_a.png"/>
<div class="caption">
Use board setup A for this example. </div></div>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga747c4d9ce46cbb1df94436ed5e5bb749"></a><!-- doxytag: member="main.c::TIMER0_PRESCALER" ref="ga747c4d9ce46cbb1df94436ed5e5bb749" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIMER0_PRESCALER&#160;&#160;&#160;(9UL)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Timer 0 prescaler </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00033">33</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga5040eaf7cc2530fd7801a1c72552767a"></a><!-- doxytag: member="main.c::TIMER0_CLOCK" ref="ga5040eaf7cc2530fd7801a1c72552767a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIMER0_CLOCK&#160;&#160;&#160;(SystemCoreClock &gt;&gt; TIMER0_PRESCALER)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Timer clock frequency </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00034">34</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<a class="anchor" id="gade0ac7f737311be0e76142d713a6f3da"></a><!-- doxytag: member="main.c::MS_TO_TIMER0_TICKS" ref="gade0ac7f737311be0e76142d713a6f3da" args="(ms)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MS_TO_TIMER0_TICKS</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">ms</td><td>)</td>
          <td>&#160;&#160;&#160;((1000000UL * ms) / (TIMER0_CLOCK))</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Converts milliseconds to timer ticks </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00036">36</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga8bb0c7f312bb8665c3377a061dae552c"></a><!-- doxytag: member="main.c::MAX_BUTTONS" ref="ga8bb0c7f312bb8665c3377a061dae552c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MAX_BUTTONS&#160;&#160;&#160;(8U)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Maximum number of buttons in use </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00038">38</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gadd186346e02f7413d2fa6e72fe5f9562"></a><!-- doxytag: member="main.c::timer0_init" ref="gadd186346e02f7413d2fa6e72fe5f9562" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void timer0_init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initializes Timer 0 peripheral. </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00062">62</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga5f89e5f7418d3a10f49b2faeab3711dd"></a><!-- doxytag: member="main.c::TIMER0_IRQHandler" ref="ga5f89e5f7418d3a10f49b2faeab3711dd" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void TIMER0_IRQHandler </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Timer 0 peripheral interrupt handler. </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00049">49</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga840291bc02cba5474a4cb46a9b9566fe"></a><!-- doxytag: member="main.c::main" ref="ga840291bc02cba5474a4cb46a9b9566fe" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="group__gpio__example.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a> function </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0. int return type required by ANSI/ISO standard. </dd></dl>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00086">86</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="ga795c8489e6b86dbbdeb0ad800e9bc48a"></a><!-- doxytag: member="main.c::timer0_cc0_period" ref="ga795c8489e6b86dbbdeb0ad800e9bc48a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint_fast16_t <a class="el" href="group__debouncer__example.html#ga795c8489e6b86dbbdeb0ad800e9bc48a">timer0_cc0_period</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Period between debouncer input reads. </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00040">40</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga904201e2b12ea5a8feacc85a67d33832"></a><!-- doxytag: member="main.c::button" ref="ga904201e2b12ea5a8feacc85a67d33832" args="[MAX_BUTTONS]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structdeb__t.html">deb_t</a> <a class="el" href="group__debouncer__example.html#ga904201e2b12ea5a8feacc85a67d33832">button</a>[MAX_BUTTONS]<code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Debounced button state holder </p>

<p>Definition at line <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html#l00041">41</a> of file <a class="el" href="nrf6310_2debouncer__example_2main_8c_source.html">main.c</a>.</p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
